home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 676-700 / 699 / reorg / english / reorg.doc < prev    next >
Text File  |  1995-03-18  |  43KB  |  1,075 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                           ReOrg V2.3
  7.  
  8.                     Shareware disk optimizer
  9.  
  10.                      English documentation
  11.  
  12.                      (C) 1992 Holger Kruse
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.        Contents
  21.        --------
  22.  
  23.        1. Conditions, Disclaimer
  24.  
  25.        2. What is ReOrg ? - Short introduction
  26.  
  27.        3. Hardware, Software needed; Installation
  28.  
  29.        4. Usage
  30.  
  31.        5. Error messages
  32.  
  33.        6. Technical details
  34.  
  35.        7. Option file format
  36.  
  37.        8. Program version, update info
  38.  
  39.        9. Acknowledgements
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.        1. Conditions, Disclaimer
  48.        -------------------------
  49.  
  50.        ReOrg is shareware. The program may be freely distributed
  51.        and copied, as long as the following conditions are
  52.        fulfilled:
  53.  
  54.         - The sales price must not be higher than the cost of
  55.           an (empty) disk plus a nominal copying fee plus
  56.           costs for shipping. The total price must not be higher
  57.           than 6 US$ or 10 DM.
  58.         - All parts of the program and the documentation must
  59.           be complete. The distribution of single parts is not
  60.           allowed.
  61.         - ReOrg or parts of it must not be sold in combination with
  62.           or as part of commercial software.
  63.         - Program and documentation must not be changed in any way.
  64.           Exception (this means: acceptable is:) the use of
  65.           archivers such as LHArc and packers like "Imploder" or
  66.           "Powerpacker", as long as it is possible to retrieve
  67.           the original program/data.
  68.  
  69.  
  70.  
  71.        I want to ask everybody, who uses ReOrg (except for one
  72.        or two test runs), to send the amount of
  73.  
  74.                       10 US$  or  15 DM
  75.  
  76.        to the following address:
  77.  
  78.                       Holger Kruse
  79.                       Ulzburger Str. 387-389
  80.                       2000 Norderstedt
  81.                       Germany
  82.  
  83.  
  84.        Please send only cash or eurocheques, do not send
  85.        stamps, american bank checks, disks etc.
  86.  
  87.        Thank you very much in advance !
  88.  
  89.        I will try and inform everybody, who as registered with
  90.        me as described above, when a new version of ReOrg
  91.        becomes available.
  92.  
  93.        Until the start of july '92, you can also reach me via
  94.        electronic mail. My (Internet-)address is:
  95.  
  96.        hkr@mcshh.hanse.de
  97.  
  98.  
  99.        I explicitly do not guarantee for the correct functioning 
  100.        of ReOrg. When you optimize disks, you always run the
  101.        risk of a data loss, of a change of your data or of
  102.        the destruction of your data. I explicitly reject any
  103.        responsibility for these or any other consequences from
  104.        the use of ReOrg whatsoever. This includes, but is not
  105.        limited to, secondary consequences, personal injuries or
  106.        other kinds on side effects.
  107.  
  108.        I hereby explicitly warn each user:
  109.        
  110.        !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  111.        !!! Optimizing a disk is always risky.        !!!
  112.        !!! I strongly recommend each user to backup  !!!
  113.        !!! or copy his disk completely before        !!!
  114.        !!! optimizing it. It is the user's           !!!
  115.        !!! responsibility to check his data for      !!!
  116.        !!! completeness and correctness after        !!!
  117.        !!! optimizing it. I explicitly reject any    !!!
  118.        !!! responsibility for damages or changes.    !!!
  119.        !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  120.  
  121.  
  122.        2. What is ReOrg ? - Short introduction
  123.        ---------------------------------------
  124.  
  125.        ReOrg is a disk optimizer, i.e. a program that
  126.        improves the physical data layout on a floppy
  127.        disk or harddisk, in order to speed up file
  128.        and directory accesses.
  129.        
  130.        ReOrg removes some problems that are caused
  131.        by AmigaDOS:
  132.        
  133.         - file fragmentation:
  134.           When new files are created, it is possible that
  135.           AmigaDOS can not store the file contents in one
  136.           single consecutive block, because there is no
  137.           such block available on the disk. In this case
  138.           AmigaDOS sometimes scatters the file contents over
  139.           the whole disk.
  140.           ReOrg removes this problem by placing the contents
  141.           of each file in a single consecutive block.
  142.  
  143.         - directory fragmentation:
  144.           In contrary to other operating systems (e.g. MSDOS),
  145.           AmigaDOS does not store directory data in a single
  146.           consecutive block. This leads to weak performance
  147.           for directory listings.
  148.           ReOrg tries to store directory data as closely together
  149.           as possible. This considerably speeds up commands like
  150.           "dir" and "lists" and the directory display within
  151.           file requesters.
  152.  
  153.         - differences in disk format:
  154.           When you use disks under Kick1.2/1.3, which have been
  155.           formatted under Kick2.04, directory accesses are often
  156.           even much slower than usual. The reason for this is, that
  157.           placement of "FileList"-blocks has been changed from
  158.           Kick1.2/1.3 to Kick2.04.
  159.           ReOrg has an option where to place "FileList"-blocks.
  160.           This means you can optimize Kick2.04-disks for use
  161.           with Kick1.2/1.3.
  162.  
  163.        ReOrg can be used with the following disk formats:
  164.        
  165.         - all currently available AmigaDOS filesystems, including
  166.          - OldFileSystem (OFS: "DOS\0")
  167.          - FastFileSystem (FFS: "DOS\1")
  168.          - new (Kick2.0)-FileSystem (includes OFS and FFS)
  169.          - International FileSystem (has been in ROM at least
  170.            since Kick2.04 and will (possibly ?) be supported
  171.            from the Shell in WB2.1: "DOS\2", "DOS\3")
  172.  
  173.         - All floppy disk and hard disk sizes are supported.
  174.           However, to optimizer large hard disk partitions,
  175.           you need a lot of memory.
  176.  
  177.         - ReOrg recognizes FileSystems, which support different
  178.           disk capacities (e.g. High-Density-Drives for
  179.           1.76 MB capacity, that are built in some new A3000s).
  180.  
  181.         - ReOrg supports "hard links" and "soft links";
  182.           however, "soft links" are not wholely supported by
  183.           Commodore yet. Therefore, ReOrg only supports the
  184.           (possibly preliminary) "soft link" implementation
  185.           of Kick2.04. I can not guarantee that this version
  186.           of ReOrg correctly handles "soft link" implementation
  187.           of future AmigaDOS versions.
  188.  
  189.         - CAUTION: DYNAMIC Ram disks, like "VD0:" ((C) ASDG)
  190.           must NOT be optimized by ReOrg. Optimizing such disks
  191.           may lead to data loss !
  192.  
  193.         - Of course, ReOrg can not optimize "RAM:". Anyway,
  194.           this would not make much sense.
  195.  
  196.         - You CAN use ReOrg to optimize your resident,
  197.           non-dynamical RAM-Disk "RAD:" ((C) by Commodore).
  198.  
  199.         - ReOrg has a one-disk-mode (optimize a single disk)
  200.           and a two-disk-mode (optimize one disk while copying
  201.           it to a different disk)
  202.  
  203.        In comparison to other disk optimizers available on
  204.        the Amiga market, ReOrg is quite fast.
  205.        Optimizing a 880 kB disk on a standard 68000 Amiga
  206.        with 1 MB of free memory usually takes about 1:30
  207.        to 1:40 minutes. On a 68030 Amiga it takes only
  208.        1:20 to 1:30 minutes.
  209.        Optimizing a 40 MB harddisk on a 68000 Amiga usually
  210.        takes around 10 to 15 minutes, but this time depends very
  211.        much on the amount of free memory, type of controller
  212.        type of processor and the degree of disk fragmentation.
  213.        If you use a 68030 Amiga and have enough memory
  214.        available, the optimization time can be reduced to
  215.        about 4 minutes.
  216.  
  217.  
  218.  
  219.  
  220.        3. Hardware, software needed; Installation
  221.        ------------------------------------------
  222.  
  223.        To use ReOrg, you need an Amiga, Kickstart 2.04
  224.        or above and enough memory.
  225.        There is also a different version of ReOrg (V1.1)
  226.        available that also works under Kickstart 1.2/1.3
  227.        The amount of memory you need is approximately:
  228.        
  229.             220 kB  (needed for the program itself)
  230.           +   7 kB for each MB of disk size
  231.           +   5 * tracksize of your disk
  232.           + 150 kB which are usually not used by ReOrg, but must be
  233.                    left to avoid low-memory situations. (For large
  234.                    partition sizes and much memory available, this
  235.                    number may become higher)
  236.  
  237.  
  238.        Examples:
  239.  
  240.        1) 880 kB floppy disk:                  40 MB harddisk:
  241.           (11 sectors/track)                   (32 sectors/track)
  242.  
  243.            220 kB                                 220 kB
  244.         +    6 kB  (7 kB * 880/1024)           +  280 kB  (7 kB * 40)
  245.         +   28 kB  (11/2 kB * 5)               +   80 kB  (32/2 kb * 5)
  246.         +  150 kB                              +  150 kB
  247.         ---------                              ---------
  248.            404 kB                                 690 kB
  249.  
  250.  
  251.           200 MB hard disk:
  252.           (32 sectors/track)
  253.  
  254.            220 kB
  255.         + 1400 kB  (7 kB * 200)
  256.         +   80 kB  (32/2 kB * 5)
  257.         +  150 kB
  258.         ---------
  259.           1850 kB
  260.  
  261.        These numbers are only rough approximations to give
  262.        you an idea how much memory you need.
  263.  
  264.        Actually for large partition sizes, ReOrg allocates
  265.        most of your memory as a cache.
  266.        This cache is the main reason why ReOrg is so fast.
  267.        For optimum speeds, the cache should have at least
  268.        2 percent of the size of your partition.
  269.  
  270.  
  271.        There is no installation required for ReOrg. In addition
  272.        to the program file "ReOrg", you do not need any
  273.        libraries, fonts etc.
  274.        However if you want to use the built-in help mode of ReOrg
  275.        the file "ReOrg.help" must be copied to the same directory
  276.        as the program file "ReOrg".
  277.  
  278.  
  279.  
  280.        4. Usage
  281.        --------
  282.  
  283.        ReOrg can be started from Shell of Workbench.
  284.        You can specify the following arguments / tool types:
  285.  
  286.          FROM=device name            source device name
  287.          TO=device name              destination device name
  288.          PUBSCREEN=screen name       name of the public screen
  289.                                      you want ReOrg to open on
  290.                                      (works since ReOrg V2.3)
  291.          SCREENMODE=typecode         This option tells ReOrg to open
  292.               e.g. =NTSC:HiRes       an own (custom) screen. As <typecode>
  293.               or   =0x19000          you can specify the name of an
  294.                                      Amiga display-mode (like in Prefs/
  295.                                      ScreenMode), e.g. "NTSC:HiRes".
  296.                                      However I recommend you specify the
  297.                                      hex code (e.g. "0x19000" for
  298.                                      NTSC:HiRes), because the hex code
  299.                                      is not changed for different
  300.                                      languages (WB2.1 ?). Valid code are e.g.:
  301.                                       0x08000:   HiRes
  302.                                       0x19000:   NTSC:HiRes
  303.                                       0x29000:   PAL:HiRes
  304.                                       0x39024:   Productivity
  305.                                       0x41000:   A2024 10Hz
  306.                                      A complete list is located in
  307.                                      the include file "graphics/displayinfo.h".
  308.          OPTFILE=option file name    name of a user-supplied
  309.                                      option file (the format of this
  310.                                      file is described below)
  311.          SETTINGS=settings           name of a settings file, that ReOrg
  312.                   file name          has previously saved (default =
  313.                                      "ReOrg.prefs")
  314.  
  315.        From Workbench ReOrg can also be started by double-clicking
  316.        on an settings file.
  317.  
  318.  
  319.        When you start ReOrg, the main window appears. ReOrg is
  320.        controlled by menus and gadgets.
  321.  
  322.  
  323.  
  324.        Description of menus:
  325.  
  326.        - ReOrg
  327.  
  328.          - About ReOrg     Displays version and copyright information
  329.  
  330.          - Help            Toggle help mode.
  331.                            In help mode the mouse pointer changes its
  332.                            imagery. When you select a menu item or a
  333.                            gadget while in help mode, ReOrg shows you
  334.                            a short explanation. You can leave help mode
  335.                            by selecting the menu item "Help" again.
  336.  
  337.          - Quit ReOrg      Quits the program
  338.  
  339.        - Settings
  340.  
  341.          - Create Icons ?  If this menu item is selected, ReOrg creates
  342.                            a Workbench icon (.info-file) whenever you save
  343.                            a settings file.
  344.  
  345.          - Load            Loads any previously saved settings file
  346.            Settings...
  347.  
  348.          - Save Settings   Saves the settings (state of all gadgets
  349.                            and menu items) in the current settings
  350.                            file (default = "ReOrg.prefs")
  351.  
  352.          - Save Settings   Saves the settings in any settings file
  353.            as...
  354.  
  355.  
  356.  
  357.        Description of gadgets:
  358.  
  359.        - Format            This gadget specifies if the destination
  360.                            disk is to be formatted.
  361.  
  362.            - Off           Do not format the destination disk.
  363.                            For all disk writes CMD_WRITE is used.
  364.                            (This only works if the destination disk
  365.                            has been formatted previously;
  366.                            default in one-disk-mode)
  367.  
  368.            - On            Only used tracks are formatted on the
  369.                            first write access. Should usually not be
  370.                            used for harddisks, but is useful for floppy
  371.                            disks.
  372.  
  373.            - All tracks    All tracks of the destination disk
  374.                            are formatted (necessary, if the
  375.                            destination disk has not been
  376.                            formatted before; default in two-disk-mode)
  377.  
  378.        - Write verify      If this gadget is activated, ReOrg checks
  379.                            if data is written correctly (verify).
  380.                            This slows down the optimization. For
  381.                            hard disks verify ist usually not necessary.
  382.  
  383.        - Workbench Mode    If this gadget is activated, Workbench
  384.                            icons will appear faster after optimization.
  385.  
  386.        - Graphical sector  If this gadget is activated, ReOrg
  387.          display           graphically shows the user which sectors it
  388.                            is currently working on during optimization.
  389.                            This makes the optimization slightly slower.
  390.  
  391.        - Advanced options  This gadget opens a window that
  392.                            contains options which are not needed
  393.                            so often.
  394.  
  395.        - Option file       You can enter the name of an option file
  396.                            in this gadget. Option files allow the
  397.                            user to specify, that certain files should
  398.                            be treated by ReOrg in a different way.
  399.                            The format of the option file is described
  400.                            below.
  401.                            The option file name can be entered
  402.                            immediately, or you can use the "Select"
  403.                            gadget to select an option file in a
  404.                            file requester. The gadget "Clear" clears
  405.                            the option file name.
  406.  
  407.        - Drive /           These gadgets are scrolling lists that
  408.          FROM Drive /      show all available drives. In one-disk-mode
  409.          TO Drive          you must choose one device name, in
  410.                            two-disk-mode, two different devices must
  411.                            be selected.
  412.  
  413.        - Mode              Lets you choose between
  414.                             - One Drive   (one-disk-mode)   and
  415.                             - Two Drives  (two-disk-mode)
  416.  
  417.        - Start             Starts the Optimization
  418.  
  419.        - Cancel            Quits ReOrg
  420.  
  421.  
  422.        Description of gadgets in the "Advanced options" window:
  423.  
  424.        - FileExt blocks    Specifies where FileExt blocks are
  425.                            stored. For a detailed description:
  426.                            See "6. Technical details"
  427.  
  428.        - Partition Half    Specifies where file contents are
  429.                            stored. For a detailed description:
  430.                            See "6. Technical details"
  431.  
  432.        - Update disk date  Normally, ReOrg increments the disk
  433.                            creation data during optimization.
  434.                            This is necessary to prevent ReOrg
  435.                            from mixing up the old disk with the
  436.                            new, optimized disk. If this gadget
  437.                            is deactivated, ReOrg does not change
  438.                            the disk creation date.
  439.                            CAUTION: If you deactivate this gadget,
  440.                            under certain circumstances your Amiga
  441.                            might crash after the optimization !
  442.  
  443.        - SIMULATE          If you activate this gadget, ReOrg does
  444.          optimization      not write the optimized data back to
  445.          only              disk. This means, the optimization is
  446.                            only "simulated". This is useful to
  447.                            find out if ReOrg will issue error messages
  448.                            during the actual optimization.
  449.  
  450.        - Read Drive        This gadget can be used to activate the
  451.          Geometry          command TD_GETGEOMETRY. This command is
  452.                            used by ReOrg to adjust to devices that
  453.                            support multiple disk formats. At this
  454.                            time, only "trackdisk.device" supports
  455.                            multiple formats to support DD disks as
  456.                            well as HD disks. However, ReOrg recognizes
  457.                            HD disks in "trackdisk.device"-based drives
  458.                            even when this gadget is deactivated.
  459.                            So you only need to activate this gadget
  460.                            if you have ANOTHER device that supports
  461.                            multiple disk formats (e.g. special disk
  462.                            drives on your SCSI bus).
  463.                            CAUTION: If you activate this gadget for
  464.                            a device, that does not understand
  465.                            TD_GETGEOMETRY, your Amiga may crash !
  466.                            So, usually, you should switch this gadget
  467.                            off !
  468.                            The function of this gadget has changed
  469.                            since ReOrg V2.1.
  470.  
  471.        - Safety Memory     In this gadget you can specify the
  472.                            amount memory that ReOrg should NOT use
  473.                            as cache. Default is 150000 Bytes, but
  474.                            you can reduce this value to 50000.
  475.                            Or you can increase the value as high
  476.                            as you wish, if you want to spare some
  477.                            of your memory for other programs.
  478.                            Values smaller than 50000 are not allowed,
  479.                            because otherwise there might not be
  480.                            enough memory left when an error occurs.
  481.  
  482.        - Small file limit  ReOrg stores large files in a seperate
  483.                            area on your disk to speed up the access
  484.                            to directory data. However, small files are
  485.                            usually stored within the directory area
  486.                            to speed up the access to those files.
  487.                            This does not affect the speed of
  488.                            directory accesses very much.
  489.                            In the "Small file limit" gadget you can
  490.                            enter the maximum size of files (in
  491.                            blocks), that should be stored within
  492.                            the directory area (default=2). Large
  493.                            values slow down the directory access
  494.                            ("dir", "list"); small values slow down
  495.                            the access to small files. When you
  496.                            optimize boot disks (e.g. for games),
  497.                            larger values can be useful.
  498.  
  499.  
  500.        There is yet another way to control ReOrg: If ReOrg
  501.        is started from Workbench, the ReOrg window becomes an
  502.        "AppWindow". This means, you can drop Workbench icons
  503.        in this window.
  504.  
  505.         - When you drop the icon of a ReOrg settings file in
  506.           the window, ReOrg loads the settings file.
  507.  
  508.         - When you drop a disk icon over one of the device
  509.           scrolling lists (Drive, FROM Drive, TO Drive),
  510.           ReOrg chooses the device name belonging to the
  511.           disk icon.
  512.  
  513.  
  514.  
  515.        When the optimization is started, ReOrg first prompts
  516.        the user to insert the disk(s). After that, a status
  517.        window appears and ReOrg starts reading and processing
  518.        the disk directory.
  519.        During this phase (status = "scanning disk"), ReOrg may
  520.        be interrupted at any time even in one-disk-mode.
  521.        At the end of this phase, ReOrg once again asks the
  522.        user to confirm that the disk should be optimized.
  523.        In one-disk-mode, ReOrg must not be interrupted or
  524.        canceled after this message, or your disk will be
  525.        corrupt.
  526.        During the actual optimization (status = "moving blocks")
  527.        ReOrg shows how much time the optimization will approximately
  528.        need. This display is regularly updated.
  529.        After this phase has been finished, in two-disk-mode ReOrg
  530.        may format unused tracks on the destination disk and copy
  531.        reserved sectors to the destination disk.
  532.        After that, ReOrg asks the user to remove the disk(s).
  533.        Finally, ReOrg shows some statistical information about
  534.        the disk and the optimization.
  535.  
  536.  
  537.        During the optimization, the status window show the
  538.        following information:
  539.  
  540.         - The number of directories and files, which ReOrg has
  541.           already processed ("done") and which ReOrg has
  542.           queued for later processing ("queued").
  543.  
  544.         - The current cache usage. If this value reaches
  545.           100% at any time during the optimization, this
  546.           means that more memory could speed up the
  547.           optimization.
  548.  
  549.         - The cache size (in absolute numbers, and relative
  550.           to the disk size)
  551.  
  552.         - The current status of ReOrg. Possible states are:
  553.           - checking disk       Before the actual optimization
  554.                                 starts, ReOrg checks if your disk
  555.                                 is a valid AmigaDOS disk.
  556.           - scanning disk       ReOrg is reading the disk directory
  557.                                 and is calculating the layout of the
  558.                                 destination disk.
  559.           - awaiting user       ReOrg is waiting for the user to
  560.             response            confirm the start of the
  561.                                 optimization.
  562.           - preparing           ReOrg is creating internal tables that
  563.             optimization        are needed for the optimization.
  564.           - moving blocks       ReOrg is optimizing the disk.
  565.           - writing bitmap      ReOrg is writing the new disk
  566.                                 bitmap.
  567.           - formatting empty    If the user selected "Format: All Tracks",
  568.             tracks              ReOrg formats all unused tracks on the
  569.                                 destination disk.
  570.           - copying reserved    ReOrg is copying reserved blocks
  571.             blocks              (boot blocks etc.).
  572.  
  573.         - The remaining time needed for the optimization (only
  574.           during the phase "moving blocks"). This value is only
  575.           an approximation of the remaining time needed. If source
  576.           and destination devices have a very different speed,
  577.           (e.g. "RAD:" to "DF0:"), the estimation is very inaccurate.
  578.  
  579.         - A graphical display, how many percent of disk blocks
  580.           have already been moved. This percentage also corresponds
  581.           to the percentage of time needed for the optimization.
  582.  
  583.         - If the user selected the gadget "Graphical sector display",
  584.           ReOrg displays on the right side of the window which sectors
  585.           are currently processed.
  586.  
  587.  
  588.  
  589.        5. Error messages
  590.        -----------------
  591.  
  592.        Error code  Meaning
  593.  
  594.          1         AmigaDOS error: The file size does not correspond
  595.                    to the number of data blocks allocated to a file.
  596.  
  597.          2         Device error: I/O error during read
  598.  
  599.          3         Device error: I/O error during write
  600.  
  601.          4         Device error: I/O error during the last write access
  602.  
  603.          5         Device error: I/O error trying to switch the motor
  604.                    of the source drive off
  605.  
  606.          6         Device error: I/O error trying to switch the motor
  607.                    of the destination drive off
  608.  
  609.          7         AmigaDOS error: Invalid block number in
  610.                    directory tree
  611.  
  612.          8         AmigaDOS error: A block is used twice (corresponds
  613.                    to the Disk-Validator error message "Key ### already set")
  614.  
  615.          9         AmigaDOS error: A control block has an invalid
  616.                    identification in the first longword (must equal 2)
  617.  
  618.         10         AmigaDOS error: A control block has an invalid
  619.                    type identification in the last longword (ReOrg
  620.                    currently recognizes types -4, -3, 1, 2, 3, 4)
  621.  
  622.         11         File error: Cannot open option file
  623.  
  624.         12         File error: Cannot read option file
  625.  
  626.         13         File error: Option file has an invalid format
  627.  
  628.         14         File error: Option file has an invalid version
  629.  
  630.         15         File error: Option file is too long (more than
  631.                    65534 lines)
  632.  
  633.         16         File error: Unexpected end of line in option file
  634.  
  635.         17         File error: Invalid option in option file
  636.  
  637.         18         File error: Invalid combination of options in
  638.                    option file
  639.  
  640.         19         Run time error: Not enough memory
  641.  
  642.         20         User mistake: No FROM-device selected
  643.  
  644.         21         User mistake: No device selected
  645.  
  646.         22         User mistake: No TO-device selected
  647.  
  648.         23         User mistake: FROM- and TO-device are the same
  649.  
  650.         24         User mistake: FROM- and TO-device are incompatible
  651.                    to each other
  652.  
  653.         25         Device error: Cannot open device
  654.  
  655.         26         Format error: Disk format unknown
  656.  
  657.         27         Format error: Disk does not have a valid AmigaDOS
  658.                    format
  659.  
  660.         28         File error: Error writing the settings file
  661.  
  662.         29         File error: Error reading the settings file
  663.  
  664.         30         File error: Help file corrupt
  665.  
  666.         31         Device error: I/O error during verify. When this
  667.                    error occurs, you can cancel the optimization,
  668.                    try again to write and read the blocks or ignore
  669.                    the error.
  670.  
  671.         32         User mistake: No disk inserted !
  672.         
  673.         33         Device error: general I/O error !
  674.         
  675.         34         User mistake: Disk is write protected !
  676.  
  677.         35         Device error: Difference between read and written
  678.                    data during verify. When this error occurs, you can
  679.                    cancel the optimization, try again to write and read
  680.                    the blocks or ignore the error.
  681.  
  682.        401         Device does not exist (Usually, this error should
  683.                    not occur).
  684.  
  685.        402         Device does not have one of the valid AmigaDOS
  686.                    formats (DOS\0, DOS\1, DOS\2, DOS\3)
  687.  
  688.        403         Block length does not equal 512 bytes.
  689.  
  690.        404         The mountlist entry "SecOrg" is not equal to 0
  691.                    (invalid format ?)
  692.  
  693.        407         The mountlist entry "Reserved" is equal to 0
  694.                    (invalid format ?)
  695.                    
  696.        408         The number of sectors per track is equal to 0
  697.        
  698.        409         Error during 'Inhibit' (Allocating/freeing drive)
  699.  
  700.        502         Warning: Invalid control block encountered while
  701.                    moving blocks.
  702.  
  703.        503         Warning: Invalid data block encountered while
  704.                    moving blocks.
  705.  
  706.        504         The mountlist entry "MaxTrans" is too small to
  707.                    read a whole track. This warning usually just
  708.                    means, that your controller does not initialize
  709.                    its drive description properly.
  710.  
  711.       1xxx         Internal Error: Error numbers larger than 1000
  712.                    are internal errors, that should usually not
  713.                    occur. If you get one of these errors, please
  714.                    inform the author of ReOrg !
  715.  
  716.  
  717.  
  718.  
  719.  
  720.        6. Technical details
  721.        --------------------
  722.  
  723.        - Option "FileExt blocks"
  724.  
  725.          Files larger than 34.3 kB (OFS) or 36 kB (FFS) require
  726.          "FileExt blocks" (also called FileList blocks).
  727.          ReOrg offers three models where to place these blocks
  728.          on the output disk:
  729.  
  730.          1) "Front"      : All FileExt blocks are placed immediately
  731.                            behind the header block. This is the default
  732.                            under Kickstart 1.2/1.3.
  733.  
  734.          2) "Mid"        : All FileExt blocks are placed behind the
  735.                            first sequence of data blocks. This is the
  736.                            default under Kickstart 2.0.
  737.  
  738.          3) "Scatter"    : FileExt blocks are scattered among the
  739.                            data blocks.
  740.  
  741.  
  742.          Recommended Settings:
  743.  
  744.          - If you want to be able to display the directory contents
  745.            of your disk under Kickstart 1.2/1.3: BE SURE TO use the
  746.            setting "FileExt blocks=Front". Otherwise the "dir"-command
  747.            gets even slower than it already is.
  748.  
  749.          - Otherwise: usually "FileExt blocks=Mid" is best for disks
  750.            that are ONLY used under Kickstart 2.0. Sometimes,
  751.            "FileExt blocks=Scatter" can be useful, if large files are
  752.            read only sequentially using small program buffers (most
  753.            C-programs use very small buffers (512 bytes)). For those
  754.            programs sequential file access gets faster, if you
  755.            choose the setting "FileExt blocks=Scatter".
  756.  
  757.          - Exception: When you reorganize Boot disks, for which you
  758.            NEVER read the directory under Kickstart 1.2/1.3 (e.g.
  759.            Game boot disks), the setting "FileExt blocks=Scatter"
  760.            often gives the best results - under Kickstart 1.2/1.3 as
  761.            well as under Kickstart 2.0.
  762.  
  763.          - Another Exception: When the disk contains large files
  764.            which are accessed in relative mode (using Seek()),
  765.            you should NOT use the setting "FileExt blocks=Scatter".
  766.  
  767.  
  768.        - Partition half
  769.  
  770.          It is possible to store file data mainly in the
  771.  
  772.           - Upper or
  773.           - Lower
  774.  
  775.          partition half. Usually there is not much difference
  776.          between both settings. The decision which setting
  777.          is better usually depends on the amount of data
  778.          on the partition.
  779.  
  780.  
  781.  
  782.        - Options "Workbench mode" and "Small file limit"
  783.  
  784.          For each file, ReOrg decides whether to store the file
  785.          contents behind the header block or in the data area.
  786.  
  787.          - data stored after the header block:
  788.            - File access gets faster
  789.            - Directory access gets slower (particularly for
  790.              large files)
  791.  
  792.          - data stored in data area:
  793.            - File access gets slower
  794.            - Directory access may get faster
  795.  
  796.        When you use the option "Workbench mode", ReOrg stores
  797.        all "#?.info" and ".backdrop" files after the header block.
  798.        This makes Workbench icons appear faster. However,
  799.        directory access from the shell may become slower.
  800.  
  801.        The option "Small file limit" makes ReOrg store the contents
  802.        of small files (default: up to 2 blocks size) after the
  803.        header block, to increase file access speed. This does not
  804.        slow down directory accesses considerably, but file access
  805.        to small files gets much faster.
  806.        If you only want to have fast directory access, you can set
  807.        this option to "0".
  808.  
  809.        Directory accesses get fastest, if you switch off "Workbench
  810.        mode" and set "Small file limit" to "0".
  811.  
  812.  
  813.  
  814.        Some details about the technical process of optimization:
  815.  
  816.        - The "bitmap" of the source disk is not needed by ReOrg.
  817.          Therefore it is not necessary to "validate" your disk
  818.          before optimizing it.
  819.  
  820.        - Before ReOrg changes anything on your disk, it
  821.          first checks the structure of your disk. However,
  822.          this check is not complete, i.e. ReOrg does not
  823.          detect all possible structural defects (btw, even
  824.          the AmigaDOS Disk-Validator does not detect and
  825.          correct all defects !).
  826.          When ReOrg reports an error in the first phase, it
  827.          has not destroyed or changed your disk yet in any
  828.          way. But when the phase "moving blocks" starts,
  829.          ReOrg must not be interrupted any more, because
  830.          in this phase ReOrg rearranges the disk layout.
  831.  
  832.        - Anyway I STRONGLY RECOMMEND to THOROUGHLY check your
  833.          disk for structural defects before optimizing it.
  834.          Otherwise ReOrg might report an error in the
  835.          "moving blocks" phase and might even destroy your
  836.          disk (although this is very unlikely).
  837.  
  838.        - If ReOrg stops or is interrupted in the "moving
  839.          blocks" phase, the following things happen:
  840.  
  841.           - Your disk is displayed on Workbench as "DF0:REOR"
  842.             (DF0 being the drive that contains your disk).
  843.           - When you try to access your disk, AmigaDOS reports
  844.             "Not a DOS disk".
  845.           - The contents of your disk are TOTALLY UNUSABLE AND
  846.             COMPLETELY DESTROYED.
  847.  
  848.          In this situation there is only one thing you can do:
  849.  
  850.          !!! Reformat your disk ("format ... quick") and !!!
  851.          !!! restore your backup.                        !!!
  852.  
  853.          Do not trust "hints" from computer magazines telling you,
  854.          you could still repair parts of your disk. I explicitly
  855.          warn you:
  856.  
  857.          !!! Do not try to repair your disk using tools like         !!!
  858.          !!! "disksalv", "fixdisk", "diskdoctor" or any commercial   !!!
  859.          !!! disk tools !                                            !!!
  860.          !!! Although you might by coincidence really restore some   !!!
  861.          !!! of your files, you will most certainly "restore" a lot  !!!
  862.          !!! of corrupt files, but you will not get an error         !!!
  863.          !!! message from your disk recovery tool. This is           !!!
  864.          !!! especially true if your disk has the FFS format.        !!!
  865.          !!! "Repairing" corrupt program files may very well lead to !!!
  866.          !!! MASSIVE computer crashes in the future. So: Always      !!!
  867.          !!! restore your backup when ReOrg does not complete the    !!!
  868.          !!! "moving blocks" phase !                                 !!!
  869.  
  870.  
  871.  
  872.  
  873.  
  874.  
  875.        7. Option file format
  876.        ---------------------
  877.  
  878.        Most users will probably not needed option files.
  879.        However, option files are useful to make some "final"
  880.        optimizations, e.g. before disks are distributed.
  881.        Especially when you optimize game boot disks, a
  882.        "perfect" optimization using option files may save
  883.        you some seconds when you boot from your disk.
  884.  
  885.        Option files allow you to change the settings of
  886.        the "FileExt blocks" option and to specify the
  887.        placement of data blocks for individual files.
  888.        These settings override the global settings for
  889.        single files.
  890.  
  891.        Example: You want to optimize a game boot disk, that
  892.                 contains a lot of files. You therefore used
  893.                 the global setting "FileExt blocks=Scatter"
  894.                 (An explanation, why this makes sense, can be
  895.                 found in the section "6. Technical details").
  896.                 The disadvantage of this setting is, that
  897.                 relative accesses to large files become slower.
  898.                 When you know, that your game often accesses a
  899.                 single large file in relative mode (let's say
  900.                 the name of this file is "graphics/dungeon.gfx"),
  901.                 you should change the setting of "FileExt blocks"
  902.                 to "Front" for this single file only. This kind
  903.                 of settings can be specified in option files.
  904.  
  905.  
  906.        Option files are ordinary ASCII text files. You can use
  907.        any ASCII text editor to create and edit them (e.g. MEmacs).
  908.  
  909.        Format:
  910.  
  911.        1st line:
  912. $1
  913.        (A dollar sign ("$") and the digit One ("1") in the first
  914.        two columns of the line)
  915.  
  916.        all other lines:
  917.  
  918. options:file name:comment
  919.  
  920.        valid options are:
  921.         I0       Data blocks of this file are not placed near
  922.                  the header block (default)
  923.         I1       Data blocks of this file are placed near the
  924.                  header block (file access gets faster, directory
  925.                  access gets slower)
  926.         E0       The same as "FileExt blocks=Front" for a single file.
  927.         E1       The same as "FileExt blocks=Scatter" for a single file.
  928.         E2       The same as "FileExt blocks=Mid" for a single file.
  929.  
  930.         You can combine several options in a single line
  931.         (e.g.: E0I1:file name:comment)
  932.         The above example:
  933. $1
  934. E0:graphics/dungeon.gfx:any comment
  935.  
  936.       Some more notes about the file format
  937.        - The file name must be specified relative to the root
  938.          of the disk, i.e. please do not write "/test/name.doc",
  939.          "sys:test/name.doc" or "diskname:test/name.doc", but
  940.          only "test/name.doc"
  941.        - Spaces and other special characters may occur in the
  942.          file name. You need not (and must not) use quotation
  943.          marks to surround the file name !
  944.        - Patterns (e,g, "*.txt" or "#?.txt") are not allowed !
  945.  
  946.  
  947.  
  948.  
  949.        8. Program version, update info
  950.        -------------------------------
  951.  
  952.  
  953.        - V2.3 (Rev 75, 20.06.1992, current version, 2nd release)       
  954.        
  955.            Changes since V2.1:
  956.              - ReOrg now correctly works with cache sizes
  957.                larger that 8 MB
  958.              - all windows use the font "topaz 8"
  959.              - ReOrg no longer crashes if an error occurs before
  960.                ReOrg has opened its window (e.g. if you specify
  961.                a wrong name for the initial settings file)
  962.              - ReOrg uses the "DrawInfo" structure to make all
  963.                texts readable even on 2-color screens
  964.              - obsolete ".info" files are treated like all other
  965.                "#?.info" files
  966.              - Real double buffering has been implemented for
  967.                all read accesses as well ==> speed increase
  968.              - menu texts are displayed in the screen default
  969.                font
  970.              - asynchronous I/O is used even in one-disk mode
  971.              - slight changes in the "moving blocks" phase to
  972.                increase speed
  973.              - Handling of TD_GETGEOMETRY greatly improved.
  974.                Crashes are much less likely now.
  975.              - Error messages #406 ("MaxTransfer to small") has
  976.                become a warning now (#504) and can be skipped by
  977.                the user
  978.              - ToolType "PUBSCREEN" works correctly
  979.              - ToolType "SCREENMODE" implemented to force ReOrg
  980.                to open on an own custom screen
  981.              - If read/write errors occur during the "moving
  982.                blocks" phase, the user can now "repeat" the
  983.                I/O or "ignore" the error. This means the
  984.                optimization can be finished even if errors
  985.                occur.
  986.              - The mountlist entry "Mask" is used to prevent
  987.                problems with old DMA controllers in combination
  988.                with turbo boards.
  989.              - Compatibility of Verify improved:
  990.                - No more errors when the device does not recognize
  991.                  CMD_UPDATE
  992.                - ReOrg automatically switches to (slower)
  993.                  synchronous verify if the device does not
  994.                  support (faster) asynchronous verify.
  995.              - Fixed a problem at the end of the optimization,
  996.                that occured if the volume had the same name
  997.                as the device.
  998.  
  999.  
  1000.        - V2.2 (several Revs, intermediate internal version)       
  1001.  
  1002.        - V2.1 (Rev 49, 28.05.1992, 1st release)       
  1003.  
  1004.  
  1005.  
  1006.  
  1007.        In addition to ReOrg V2.3, there is another current
  1008.        ReOrg version, that also runs under Kickstart 1.2/1.3.
  1009.        The version number is V1.1.
  1010.  
  1011.        If you have ReOrg versions V0.9, V0.99 or V1.0,
  1012.        please DELETE them. They are internal beta-test versions.
  1013.  
  1014.        I will try and further improve ReOrg V2.3 if I have
  1015.        time for it. Registered users will get a notification
  1016.        when new versions of ReOrg get available, that contain
  1017.        significant changes or enhancements.
  1018.  
  1019.        But I will probably not change the Kickstart 1.2/1.3-
  1020.        compatible ReOrg version V1.1 any more. I guess that
  1021.        most Users will upgrade to Kickstart 2.04 after some
  1022.        time anyway, so they can use ReOrg V2.3.
  1023.  
  1024.        Besides ReOrg V2.3 contains some improvements that
  1025.        have not been implemented in ReOrg V1.1. One of them
  1026.        is: ReOrg V2.3 needs much less memory to optimize large
  1027.        hard disk partitions than ReOrg V1.1.
  1028.  
  1029.        In order to be able to improve / correct ReOrg, I would like
  1030.        to ask every user to do the following things:
  1031.  
  1032.          - send me the registration fee
  1033.  
  1034.          - send me bug reports, if you find any bugs
  1035.  
  1036.          - give me hints how to improve ReOrg
  1037.  
  1038.        Thank you very much in advance !
  1039.  
  1040.  
  1041.        My personal future plans for ReOrg, if I have time for them:
  1042.  
  1043.          - Implement an option to convert disks between the
  1044.            "ordinary" disk formats to/from the International
  1045.            FileSystem format
  1046.            (i.e. DOS\0 <--> DOS\2, and DOS\1 <--> DOS\3)
  1047.          - Support for "locale.library" to adapt ReOrg to
  1048.            different languages
  1049.  
  1050.        I will be thankful for other ideas.
  1051.  
  1052.  
  1053.  
  1054.        9. Acknowledgements
  1055.        -------------------
  1056.  
  1057.  
  1058.        Thank you to all beta-testers of ReOrg !
  1059.        These are:
  1060.  
  1061.        Thomas Esser, Oliver Kasper, Carsten Lechte, Holger Lubitz,
  1062.        Michael Rohrdrommel, Kai Siering, Christian Soltenborn,
  1063.        Christian Wolf and Michael Zielinski.
  1064.  
  1065.  
  1066.        Thank you to Christian Wolf for distributing
  1067.        ReOrg via FTP !
  1068.  
  1069.  
  1070.        ... last but not least many thanks in advance to all
  1071.        ReOrg users who send me the registration fee !
  1072.  
  1073.  
  1074.        Holger Kruse
  1075.